Skip to content

Refactor internal package structure #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Conversation

kgodlewski
Copy link
Contributor

Move things around according to their responsibility to cleanup the structure. I did not make it too elaborate for the time being, just an overdue cleanup.

Packages are as follows:

  • api - everything that is user-facing: Run & exceptions
  • net - code related to communicating with the backend
  • sync - sync process, queues etc
  • util - things like logging, SharedVar, ProcessLink

Copy link
Collaborator

@PatrykGala PatrykGala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that moving the exceptions to a new location might break backward compatibility.

@SiddhantSadangi
Copy link
Member

I noticed that moving the exceptions to a new location might break backward compatibility.

@PatrykGala - shouldn't that be fine as we are in beta and are being used only by limited beta-testers who we can directly reach out to upgrade to newer versions?

@PatrykGala
Copy link
Collaborator

@PatrykGala - shouldn't that be fine as we are in beta and are being used only by limited beta-testers who we can directly reach out to upgrade to newer versions?
We can break compatibility with communication to users.

@kgodlewski
Copy link
Contributor Author

I moved the file so the import statement is now more user-friendly, I think it's a good catch. The api package is for internal organisation purposes, so it shouldn't be affecting UX

@PatrykGala PatrykGala merged commit 94eb469 into main Nov 25, 2024
10 checks passed
@PatrykGala PatrykGala deleted the kg/internal-refactor branch November 25, 2024 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants